Azure IoT Central (preview:2022-10-31)

2025/10/23 • 120 new methods

ApiTokens_List (new)
Description :  Get the list of API tokens in an application. The token value will never be returned for security reasons.
Reference :  Link ¶

⚼ Request

GET:  /apiTokens
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of API tokens. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the API token. ,
Required: False ,
}
string ,
token:
{
Description: Value of the API token. ,
Required: False ,
}
string ,
expiry:
{
Description: String-formatted date representing the time when the token expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of API tokens. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
ApiTokens_Get (new)
Description :  Get an API token by ID.
Reference :  Link ¶

⚼ Request

GET:  /apiTokens/{tokenId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
tokenId:
{
Description: Unique ID for the API token. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the API token. ,
Required: False ,
}
string ,
token:
{
Description: Value of the API token. ,
Required: False ,
}
string ,
expiry:
{
Description: String-formatted date representing the time when the token expires. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
ApiTokens_Create (new)
Description :  Create a new API token in the application to use in the IoT Central public API. The token value will be returned in the response, and won't be returned again in subsequent requests.
Reference :  Link ¶

⚼ Request

PUT:  /apiTokens/{tokenId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
tokenId:
{
Description: Unique ID for the API token. ,
Required: True ,
}
string ,
body:
{
Description: API token body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the API token. ,
Required: False ,
}
string ,
token:
{
Description: Value of the API token. ,
Required: False ,
}
string ,
expiry:
{
Description: String-formatted date representing the time when the token expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the API token. ,
Required: False ,
}
string ,
token:
{
Description: Value of the API token. ,
Required: False ,
}
string ,
expiry:
{
Description: String-formatted date representing the time when the token expires. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
ApiTokens_Remove (new)
Description :  Delete an API token.
Reference :  Link ¶

⚼ Request

DELETE:  /apiTokens/{tokenId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
tokenId:
{
Description: Unique ID for the API token. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Dashboards_List (new)
Description :  Get the list of dashboards in an application.
Reference :  Link ¶

⚼ Request

GET:  /dashboards
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
filter:
{
Description: An expression on the resource type that selects the resources to be returned. ,
Required: False ,
}
string ,
maxpagesize:
{
Description: The maximum number of resources to return from one response. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: An expression that specify the order of the returned resources. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of dashboards. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the dashboard. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the dashboard. ,
Required: True ,
}
string ,
tiles:
{
Description: The tiles displayed by the dashboard. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the tile. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the tile. ,
Required: True ,
}
string ,
configuration:
{
Description: The configuration for the tile ,
Required: True ,
}
{
type:
{
Description: The type of widget the tile renders ,
Required: True ,
}
string ,
}
,
height:
{
Description: Height of the tile ,
Required: True ,
}
number ,
width:
{
Description: Width of the tile ,
Required: True ,
}
number ,
x:
{
Description: Horizontal position of the tile ,
Required: True ,
}
number ,
y:
{
Description: Vertical position of the tile ,
Required: True ,
}
number ,
}
,
]
,
personal:
{
Description: Whether the dashboard is personal and can only be viewed by the current user. ,
Required: False ,
}
boolean ,
favorite:
{
Description: Whether the dashboard is favorited or not ,
Required: False ,
}
boolean ,
etag:
{
Description: Etag to prevent conflict when updating the dashboard. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization the dashboard belongs to. If not present, the dashboard is root-level or personal. only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next page of dashboards. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Dashboards_Get (new)
Description :  Get a dashboard by ID.
Reference :  Link ¶

⚼ Request

GET:  /dashboards/{dashboardId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
dashboardId:
{
Description: Unique ID for the dashboard. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the dashboard. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the dashboard. ,
Required: True ,
}
string ,
tiles:
{
Description: The tiles displayed by the dashboard. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the tile. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the tile. ,
Required: True ,
}
string ,
configuration:
{
Description: The configuration for the tile ,
Required: True ,
}
{
type:
{
Description: The type of widget the tile renders ,
Required: True ,
}
string ,
}
,
height:
{
Description: Height of the tile ,
Required: True ,
}
number ,
width:
{
Description: Width of the tile ,
Required: True ,
}
number ,
x:
{
Description: Horizontal position of the tile ,
Required: True ,
}
number ,
y:
{
Description: Vertical position of the tile ,
Required: True ,
}
number ,
}
,
]
,
personal:
{
Description: Whether the dashboard is personal and can only be viewed by the current user. ,
Required: False ,
}
boolean ,
favorite:
{
Description: Whether the dashboard is favorited or not ,
Required: False ,
}
boolean ,
etag:
{
Description: Etag to prevent conflict when updating the dashboard. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization the dashboard belongs to. If not present, the dashboard is root-level or personal. only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Dashboards_Create (new)
Description :  Create a dashboard
Reference :  Link ¶

⚼ Request

PUT:  /dashboards/{dashboardId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
dashboardId:
{
Description: Unique ID for the dashboard. ,
Required: True ,
}
string ,
body:
{
Description: Dashboard definition. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the dashboard. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the dashboard. ,
Required: True ,
}
string ,
tiles:
{
Description: The tiles displayed by the dashboard. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the tile. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the tile. ,
Required: True ,
}
string ,
configuration:
{
Description: The configuration for the tile ,
Required: True ,
}
{
type:
{
Description: The type of widget the tile renders ,
Required: True ,
}
string ,
}
,
height:
{
Description: Height of the tile ,
Required: True ,
}
number ,
width:
{
Description: Width of the tile ,
Required: True ,
}
number ,
x:
{
Description: Horizontal position of the tile ,
Required: True ,
}
number ,
y:
{
Description: Vertical position of the tile ,
Required: True ,
}
number ,
}
,
]
,
personal:
{
Description: Whether the dashboard is personal and can only be viewed by the current user. ,
Required: False ,
}
boolean ,
favorite:
{
Description: Whether the dashboard is favorited or not ,
Required: False ,
}
boolean ,
etag:
{
Description: Etag to prevent conflict when updating the dashboard. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization the dashboard belongs to. If not present, the dashboard is root-level or personal. only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the dashboard. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the dashboard. ,
Required: True ,
}
string ,
tiles:
{
Description: The tiles displayed by the dashboard. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the tile. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the tile. ,
Required: True ,
}
string ,
configuration:
{
Description: The configuration for the tile ,
Required: True ,
}
{
type:
{
Description: The type of widget the tile renders ,
Required: True ,
}
string ,
}
,
height:
{
Description: Height of the tile ,
Required: True ,
}
number ,
width:
{
Description: Width of the tile ,
Required: True ,
}
number ,
x:
{
Description: Horizontal position of the tile ,
Required: True ,
}
number ,
y:
{
Description: Vertical position of the tile ,
Required: True ,
}
number ,
}
,
]
,
personal:
{
Description: Whether the dashboard is personal and can only be viewed by the current user. ,
Required: False ,
}
boolean ,
favorite:
{
Description: Whether the dashboard is favorited or not ,
Required: False ,
}
boolean ,
etag:
{
Description: Etag to prevent conflict when updating the dashboard. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization the dashboard belongs to. If not present, the dashboard is root-level or personal. only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Dashboards_Update (new)
Description :  Update a dashboard
Reference :  Link ¶

⚼ Request

PATCH:  /dashboards/{dashboardId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
dashboardId:
{
Description: Unique ID for the dashboard. ,
Required: True ,
}
string ,
body:
{
Description: Dashboard definition. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the dashboard. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the dashboard. ,
Required: True ,
}
string ,
tiles:
{
Description: The tiles displayed by the dashboard. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the tile. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the tile. ,
Required: True ,
}
string ,
configuration:
{
Description: The configuration for the tile ,
Required: True ,
}
{
type:
{
Description: The type of widget the tile renders ,
Required: True ,
}
string ,
}
,
height:
{
Description: Height of the tile ,
Required: True ,
}
number ,
width:
{
Description: Width of the tile ,
Required: True ,
}
number ,
x:
{
Description: Horizontal position of the tile ,
Required: True ,
}
number ,
y:
{
Description: Vertical position of the tile ,
Required: True ,
}
number ,
}
,
]
,
personal:
{
Description: Whether the dashboard is personal and can only be viewed by the current user. ,
Required: False ,
}
boolean ,
favorite:
{
Description: Whether the dashboard is favorited or not ,
Required: False ,
}
boolean ,
etag:
{
Description: Etag to prevent conflict when updating the dashboard. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization the dashboard belongs to. If not present, the dashboard is root-level or personal. only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Dashboards_Remove (new)
Description :  Delete a dashboard
Reference :  Link ¶

⚼ Request

DELETE:  /dashboards/{dashboardId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
dashboardId:
{
Description: Unique ID for the dashboard. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Destinations_List (new)
Description :  Get the list of destinations in an application.
Reference :  Link ¶

⚼ Request

GET:  /dataExport/destinations
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of destinations. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the destination. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the destination. ,
Required: True ,
}
string ,
type:
{
Description: The type of destination configuration. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of destinations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Destinations_Get (new)
Description :  Get a destination by ID.
Reference :  Link ¶

⚼ Request

GET:  /dataExport/destinations/{destinationId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
destinationId:
{
Description: Unique ID for the destination. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the destination. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the destination. ,
Required: True ,
}
string ,
type:
{
Description: The type of destination configuration. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Destinations_Create (new)
Description :  Create or update a definition for where to send data.
Reference :  Link ¶

⚼ Request

PUT:  /dataExport/destinations/{destinationId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
destinationId:
{
Description: Unique ID for the destination. ,
Required: True ,
}
string ,
body:
{
Description: Destination body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the destination. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the destination. ,
Required: True ,
}
string ,
type:
{
Description: The type of destination configuration. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the destination. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the destination. ,
Required: True ,
}
string ,
type:
{
Description: The type of destination configuration. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Destinations_Update (new)
Description :  Perform an incremental update to a destination.
Reference :  Link ¶

⚼ Request

PATCH:  /dataExport/destinations/{destinationId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
destinationId:
{
Description: Unique ID for the destination. ,
Required: True ,
}
string ,
body:
{
Description: Destination patch body. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the destination. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the destination. ,
Required: True ,
}
string ,
type:
{
Description: The type of destination configuration. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Destinations_Remove (new)
Description :  Delete a destination.
Reference :  Link ¶

⚼ Request

DELETE:  /dataExport/destinations/{destinationId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
destinationId:
{
Description: Unique ID for the destination. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Destinations_ListExports (new)
Description :  List all exports connected to the given destination.
Reference :  Link ¶

⚼ Request

GET:  /dataExport/destinations/{destinationId}/exports
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
destinationId:
{
Description: Unique ID for the destination. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of exports. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the export. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the export. ,
Required: True ,
}
string ,
enabled:
{
Description: Toggle to start/stop an export from sending data. ,
Required: True ,
}
boolean ,
source:
{
Description: The type of data to export. ,
Enum:
{
telemetry: Destination source from device telemetry ,
properties: Destination source from device properties ,
deviceLifecycle: Destination source from device lifecycle ,
deviceTemplateLifecycle: Destination source from device template lifecycle ,
deviceConnectivity: Destination source from device connectivity ,
audit: Destination source from audit logs ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Query defining which events from the source should be exported. ,
Required: False ,
}
string ,
enrichments:
{
Description: Additional pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send. ,
Required: False ,
}
object ,
destinations:
{
Description: The list of destinations to which the export should send data. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the destination where data should be sent. ,
Required: True ,
}
string ,
transform:
{
Description: Query for transforming the message structure to a particular output. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next page of exports. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Exports_List (new)
Description :  Get the list of exports in an application.
Reference :  Link ¶

⚼ Request

GET:  /dataExport/exports
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of exports. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the export. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the export. ,
Required: True ,
}
string ,
enabled:
{
Description: Toggle to start/stop an export from sending data. ,
Required: True ,
}
boolean ,
source:
{
Description: The type of data to export. ,
Enum:
{
telemetry: Destination source from device telemetry ,
properties: Destination source from device properties ,
deviceLifecycle: Destination source from device lifecycle ,
deviceTemplateLifecycle: Destination source from device template lifecycle ,
deviceConnectivity: Destination source from device connectivity ,
audit: Destination source from audit logs ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Query defining which events from the source should be exported. ,
Required: False ,
}
string ,
enrichments:
{
Description: Additional pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send. ,
Required: False ,
}
object ,
destinations:
{
Description: The list of destinations to which the export should send data. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the destination where data should be sent. ,
Required: True ,
}
string ,
transform:
{
Description: Query for transforming the message structure to a particular output. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next page of exports. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Exports_Get (new)
Description :  Get an export by ID.
Reference :  Link ¶

⚼ Request

GET:  /dataExport/exports/{exportId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
exportId:
{
Description: Unique ID for the export. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the export. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the export. ,
Required: True ,
}
string ,
enabled:
{
Description: Toggle to start/stop an export from sending data. ,
Required: True ,
}
boolean ,
source:
{
Description: The type of data to export. ,
Enum:
{
telemetry: Destination source from device telemetry ,
properties: Destination source from device properties ,
deviceLifecycle: Destination source from device lifecycle ,
deviceTemplateLifecycle: Destination source from device template lifecycle ,
deviceConnectivity: Destination source from device connectivity ,
audit: Destination source from audit logs ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Query defining which events from the source should be exported. ,
Required: False ,
}
string ,
enrichments:
{
Description: Additional pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send. ,
Required: False ,
}
object ,
destinations:
{
Description: The list of destinations to which the export should send data. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the destination where data should be sent. ,
Required: True ,
}
string ,
transform:
{
Description: Query for transforming the message structure to a particular output. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Exports_Create (new)
Description :  Create or update a definition for exporting data. Also used to connect or disconnect an export from destinations.
Reference :  Link ¶

⚼ Request

PUT:  /dataExport/exports/{exportId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
exportId:
{
Description: Unique ID for the export. ,
Required: True ,
}
string ,
body:
{
Description: Export body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the export. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the export. ,
Required: True ,
}
string ,
enabled:
{
Description: Toggle to start/stop an export from sending data. ,
Required: True ,
}
boolean ,
source:
{
Description: The type of data to export. ,
Enum:
{
telemetry: Destination source from device telemetry ,
properties: Destination source from device properties ,
deviceLifecycle: Destination source from device lifecycle ,
deviceTemplateLifecycle: Destination source from device template lifecycle ,
deviceConnectivity: Destination source from device connectivity ,
audit: Destination source from audit logs ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Query defining which events from the source should be exported. ,
Required: False ,
}
string ,
enrichments:
{
Description: Additional pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send. ,
Required: False ,
}
object ,
destinations:
{
Description: The list of destinations to which the export should send data. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the destination where data should be sent. ,
Required: True ,
}
string ,
transform:
{
Description: Query for transforming the message structure to a particular output. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the export. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the export. ,
Required: True ,
}
string ,
enabled:
{
Description: Toggle to start/stop an export from sending data. ,
Required: True ,
}
boolean ,
source:
{
Description: The type of data to export. ,
Enum:
{
telemetry: Destination source from device telemetry ,
properties: Destination source from device properties ,
deviceLifecycle: Destination source from device lifecycle ,
deviceTemplateLifecycle: Destination source from device template lifecycle ,
deviceConnectivity: Destination source from device connectivity ,
audit: Destination source from audit logs ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Query defining which events from the source should be exported. ,
Required: False ,
}
string ,
enrichments:
{
Description: Additional pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send. ,
Required: False ,
}
object ,
destinations:
{
Description: The list of destinations to which the export should send data. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the destination where data should be sent. ,
Required: True ,
}
string ,
transform:
{
Description: Query for transforming the message structure to a particular output. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Exports_Update (new)
Description :  Perform an incremental update to an export.
Reference :  Link ¶

⚼ Request

PATCH:  /dataExport/exports/{exportId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
exportId:
{
Description: Unique ID for the export. ,
Required: True ,
}
string ,
body:
{
Description: Export patch body. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the export. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the export. ,
Required: True ,
}
string ,
enabled:
{
Description: Toggle to start/stop an export from sending data. ,
Required: True ,
}
boolean ,
source:
{
Description: The type of data to export. ,
Enum:
{
telemetry: Destination source from device telemetry ,
properties: Destination source from device properties ,
deviceLifecycle: Destination source from device lifecycle ,
deviceTemplateLifecycle: Destination source from device template lifecycle ,
deviceConnectivity: Destination source from device connectivity ,
audit: Destination source from audit logs ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Query defining which events from the source should be exported. ,
Required: False ,
}
string ,
enrichments:
{
Description: Additional pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send. ,
Required: False ,
}
object ,
destinations:
{
Description: The list of destinations to which the export should send data. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the destination where data should be sent. ,
Required: True ,
}
string ,
transform:
{
Description: Query for transforming the message structure to a particular output. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Exports_Remove (new)
Description :  Delete an export.
Reference :  Link ¶

⚼ Request

DELETE:  /dataExport/exports/{exportId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
exportId:
{
Description: Unique ID for the export. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Exports_ListDestinations (new)
Description :  List all destinations connected to the given export.
Reference :  Link ¶

⚼ Request

GET:  /dataExport/exports/{exportId}/destinations
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
exportId:
{
Description: Unique ID for the export. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of destinations. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the destination. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the destination. ,
Required: True ,
}
string ,
type:
{
Description: The type of destination configuration. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of destinations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeploymentManifests_List (new)
Description :  Get the list of deployment manifests.
Reference :  Link ¶

⚼ Request

GET:  /deploymentManifests
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: The maximum number of resources to return from one response. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: An expression on the resource type that selects the resources to be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of deployment manifests. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next page of deployment manifests. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeploymentManifests_Get (new)
Description :  Get a deployment manifest by ID.
Reference :  Link ¶

⚼ Request

GET:  /deploymentManifests/{deploymentManifestId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deploymentManifestId:
{
Description: Unique ID for the deployment manifest. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeploymentManifests_Create (new)
Description :  Create a new deployment manifest.
Reference :  Link ¶

⚼ Request

PUT:  /deploymentManifests/{deploymentManifestId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deploymentManifestId:
{
Description: Unique ID for the deployment manifest. ,
Required: True ,
}
string ,
body:
{
Description: deployment manifest body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeploymentManifests_Update (new)
Description :  Update an existing deployment manifest.
Reference :  Link ¶

⚼ Request

PATCH:  /deploymentManifests/{deploymentManifestId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deploymentManifestId:
{
Description: Unique ID for the deployment manifest. ,
Required: True ,
}
string ,
body:
{
Description: Deployment manifest patch body. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeploymentManifests_Remove (new)
Description :  Delete a deployment manifest.
Reference :  Link ¶

⚼ Request

DELETE:  /deploymentManifests/{deploymentManifestId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deploymentManifestId:
{
Description: Unique ID for the deployment manifest. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeviceGroups_List (new)
Description :  Get the list of device groups in an application.
Reference :  Link ¶

⚼ Request

GET:  /deviceGroups
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
filter:
{
Description: An expression on the resource type that selects the resources to be returned. ,
Required: False ,
}
string ,
maxpagesize:
{
Description: The maximum number of resources to return from one response. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: An expression that specify the order of the returned resources. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device groups. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the device group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device group. ,
Required: True ,
}
string ,
filter:
{
Description: Query defining which devices should be in this group, [Query Language Reference](https://aka.ms/iotcquery). ,
Required: True ,
}
string ,
description:
{
Description: Short summary of device group. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device group updates. ,
Required: False ,
}
string ,
organizations:
{
Description: List of organization IDs of the device group, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device groups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeviceGroups_Get (new)
Description :  Get the device group by ID.
Reference :  Link ¶

⚼ Request

GET:  /deviceGroups/{deviceGroupId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceGroupId:
{
Description: Unique ID for the device group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device group. ,
Required: True ,
}
string ,
filter:
{
Description: Query defining which devices should be in this group, [Query Language Reference](https://aka.ms/iotcquery). ,
Required: True ,
}
string ,
description:
{
Description: Short summary of device group. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device group updates. ,
Required: False ,
}
string ,
organizations:
{
Description: List of organization IDs of the device group, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeviceGroups_Create (new)
Description :  Create or update a device group.
Reference :  Link ¶

⚼ Request

PUT:  /deviceGroups/{deviceGroupId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceGroupId:
{
Description: Unique ID for the device group. ,
Required: True ,
}
string ,
body:
{
Description: Device group body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the device group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device group. ,
Required: True ,
}
string ,
filter:
{
Description: Query defining which devices should be in this group, [Query Language Reference](https://aka.ms/iotcquery). ,
Required: True ,
}
string ,
description:
{
Description: Short summary of device group. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device group updates. ,
Required: False ,
}
string ,
organizations:
{
Description: List of organization IDs of the device group, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device group. ,
Required: True ,
}
string ,
filter:
{
Description: Query defining which devices should be in this group, [Query Language Reference](https://aka.ms/iotcquery). ,
Required: True ,
}
string ,
description:
{
Description: Short summary of device group. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device group updates. ,
Required: False ,
}
string ,
organizations:
{
Description: List of organization IDs of the device group, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeviceGroups_Update (new)
Description :  Update an existing device group by ID.
Reference :  Link ¶

⚼ Request

PATCH:  /deviceGroups/{deviceGroupId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceGroupId:
{
Description: Unique ID for the device group. ,
Required: True ,
}
string ,
body:
{
Description: Device group patch body. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device group. ,
Required: True ,
}
string ,
filter:
{
Description: Query defining which devices should be in this group, [Query Language Reference](https://aka.ms/iotcquery). ,
Required: True ,
}
string ,
description:
{
Description: Short summary of device group. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device group updates. ,
Required: False ,
}
string ,
organizations:
{
Description: List of organization IDs of the device group, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeviceGroups_Remove (new)
Description :  Delete a device group.
Reference :  Link ¶

⚼ Request

DELETE:  /deviceGroups/{deviceGroupId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceGroupId:
{
Description: Unique ID for the device group. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeviceGroups_GetDevices (new)
Description :  Get the list of devices by device group ID.
Reference :  Link ¶

⚼ Request

GET:  /deviceGroups/{deviceGroupId}/devices
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceGroupId:
{
Description: Unique ID for the device group. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: The maximum number of resources to return from one response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The collection of devices belonging to the device group. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
template:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the device connection to IoT Central has been enabled. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
organizations:
{
Description: List of organization IDs that the device is a part of, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: The type of the device. ,
Required: False ,
}
[
string ,
]
,
deploymentManifest:
{
Description: The deployment manifest assigned to the device. ,
Required: False ,
}
{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page of devices in the group. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeviceTemplates_List (new)
Description :  Get the list of device templates in an application with basic ODATA support (maxpagesize, filter, orderby), [more details](https://aka.ms/iotcentralodatasupport).
Reference :  Link ¶

⚼ Request

GET:  /deviceTemplates
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
filter:
{
Description: An expression on the resource type that selects the resources to be returned. ,
Required: False ,
}
string ,
maxpagesize:
{
Description: The maximum number of resources to return from one response. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: An expression that specify the order of the returned resources. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device templates. ,
Required: True ,
}
[
{
@id:
{
Description: Unique ID of the device template. ,
Required: False ,
}
string ,
@type:
{
Description: The JSON-LD types of this device template. ,
Required: True ,
}
[
string ,
]
,
etag:
{
Description: ETag used to prevent conflict in device template updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device template. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the device template. ,
Required: False ,
}
string ,
capabilityModel:
{
Description: The capability model utilized by this device template. ,
Required: True ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device templates. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeviceTemplates_Get (new)
Description :  Get a device template by ID
Reference :  Link ¶

⚼ Request

GET:  /deviceTemplates/{deviceTemplateId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceTemplateId:
{
Description: Unique [Digital Twin Model Identifier](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier) of the device template. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
@id:
{
Description: Unique ID of the device template. ,
Required: False ,
}
string ,
@type:
{
Description: The JSON-LD types of this device template. ,
Required: True ,
}
[
string ,
]
,
etag:
{
Description: ETag used to prevent conflict in device template updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device template. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the device template. ,
Required: False ,
}
string ,
capabilityModel:
{
Description: The capability model utilized by this device template. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeviceTemplates_Create (new)
Description :  Publish a new device template. Default views will be automatically generated for new device templates created this way.
Reference :  Link ¶

⚼ Request

PUT:  /deviceTemplates/{deviceTemplateId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceTemplateId:
{
Description: Unique [Digital Twin Model Identifier](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier) of the device template. ,
Required: True ,
}
string ,
body:
{
Description: Device template body. ,
Required: True ,
}
{
@id:
{
Description: Unique ID of the device template. ,
Required: False ,
}
string ,
@type:
{
Description: The JSON-LD types of this device template. ,
Required: True ,
}
[
string ,
]
,
etag:
{
Description: ETag used to prevent conflict in device template updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device template. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the device template. ,
Required: False ,
}
string ,
capabilityModel:
{
Description: The capability model utilized by this device template. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (200)

{
@id:
{
Description: Unique ID of the device template. ,
Required: False ,
}
string ,
@type:
{
Description: The JSON-LD types of this device template. ,
Required: True ,
}
[
string ,
]
,
etag:
{
Description: ETag used to prevent conflict in device template updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device template. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the device template. ,
Required: False ,
}
string ,
capabilityModel:
{
Description: The capability model utilized by this device template. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeviceTemplates_Update (new)
Description :  Update the cloud properties and overrides of an existing device template via patch.
Reference :  Link ¶

⚼ Request

PATCH:  /deviceTemplates/{deviceTemplateId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceTemplateId:
{
Description: Unique [Digital Twin Model Identifier](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier) of the device template. ,
Required: True ,
}
string ,
body:
{
Description: Device template patch body. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
@id:
{
Description: Unique ID of the device template. ,
Required: False ,
}
string ,
@type:
{
Description: The JSON-LD types of this device template. ,
Required: True ,
}
[
string ,
]
,
etag:
{
Description: ETag used to prevent conflict in device template updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device template. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the device template. ,
Required: False ,
}
string ,
capabilityModel:
{
Description: The capability model utilized by this device template. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
DeviceTemplates_Remove (new)
Description :  Delete an existing device template by device ID.
Reference :  Link ¶

⚼ Request

DELETE:  /deviceTemplates/{deviceTemplateId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceTemplateId:
{
Description: Unique [Digital Twin Model Identifier](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier) of the device template. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_List (new)
Description :  Get the list of devices in an application with basic ODATA support (maxpagesize, filter, orderby), [more details](https://aka.ms/iotcentralodatasupport).
Reference :  Link ¶

⚼ Request

GET:  /devices
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
filter:
{
Description: An expression on the resource type that selects the resources to be returned. ,
Required: False ,
}
string ,
maxpagesize:
{
Description: The maximum number of resources to return from one response. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: An expression that specify the order of the returned resources. ,
Required: False ,
}
string ,
expand:
{
Description: The query parameter for including requested entities in response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of devices. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
template:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the device connection to IoT Central has been enabled. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
organizations:
{
Description: List of organization IDs that the device is a part of, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: The type of the device. ,
Required: False ,
}
[
string ,
]
,
deploymentManifest:
{
Description: The deployment manifest assigned to the device. ,
Required: False ,
}
{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page of devices. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_Get (new)
Description :  Get details about an existing device by device ID.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
expand:
{
Description: The query parameter for including requested entities in response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
template:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the device connection to IoT Central has been enabled. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
organizations:
{
Description: List of organization IDs that the device is a part of, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: The type of the device. ,
Required: False ,
}
[
string ,
]
,
deploymentManifest:
{
Description: The deployment manifest assigned to the device. ,
Required: False ,
}
{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_Create (new)
Description :  Create a new device.
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Device body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
template:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the device connection to IoT Central has been enabled. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
organizations:
{
Description: List of organization IDs that the device is a part of, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: The type of the device. ,
Required: False ,
}
[
string ,
]
,
deploymentManifest:
{
Description: The deployment manifest assigned to the device. ,
Required: False ,
}
{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
expand:
{
Description: The query parameter for including requested entities in response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
template:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the device connection to IoT Central has been enabled. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
organizations:
{
Description: List of organization IDs that the device is a part of, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: The type of the device. ,
Required: False ,
}
[
string ,
]
,
deploymentManifest:
{
Description: The deployment manifest assigned to the device. ,
Required: False ,
}
{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_Update (new)
Description :  Update an existing device by ID.
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Device patch body. ,
Required: True ,
}
object ,
expand:
{
Description: The query parameter for including requested entities in response. ,
Required: False ,
}
string ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
template:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the device connection to IoT Central has been enabled. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
organizations:
{
Description: List of organization IDs that the device is a part of, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: The type of the device. ,
Required: False ,
}
[
string ,
]
,
deploymentManifest:
{
Description: The deployment manifest assigned to the device. ,
Required: False ,
}
{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_Remove (new)
Description :  Delete an existing device by device ID.
Reference :  Link ¶

⚼ Request

DELETE:  /devices/{deviceId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
expand:
{
Description: The query parameter for including requested entities in response. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_ApplyManifest (new)
Description :  Apply a deployment manifest to an edge device.
Reference :  Link ¶

⚼ Request

POST:  /devices/{deviceId}/applyDeploymentManifest
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Deployment Manifest data. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the deployment manifest. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the deployment manifest. ,
Required: False ,
}
string ,
data:
{
Description: Content of the the deployment manifest. ,
Required: True ,
}
object ,
etag:
{
Description: Etag to prevent conflict when updating the deployment manifest. ,
Required: False ,
}
string ,
organizations:
{
Description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetAttestation (new)
Description :  Get device attestation
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/attestation
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_CreateAttestation (new)
Description :  Create an individual device attestation
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/attestation
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Individual device attestation body. ,
Required: True ,
}
{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_UpdateAttestation (new)
Description :  Update an individual device attestation via patch
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/attestation
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Individual device attestation patch body. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_RemoveAttestation (new)
Description :  Remove an individual device attestation
Reference :  Link ¶

⚼ Request

DELETE:  /devices/{deviceId}/attestation
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetCommandHistory (new)
Description :  Get device command history
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device command executions. ,
Required: True ,
}
[
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device command executions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_RunCommand (new)
Description :  Run a command on a device.
Reference :  Link ¶

⚼ Request

POST:  /devices/{deviceId}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
body:
{
Description: Device command body. ,
Required: True ,
}
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_ListComponents (new)
Description :  List the components present in a device
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/components
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of entities. ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: URL to get the next page of entities. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetComponentCommandHistory (new)
Description :  Get component command history
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/components/{componentName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device command executions. ,
Required: True ,
}
[
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device command executions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_RunComponentCommand (new)
Description :  Run a command on a component.
Reference :  Link ¶

⚼ Request

POST:  /devices/{deviceId}/components/{componentName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
body:
{
Description: Device command body. ,
Required: True ,
}
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetComponentProperties (new)
Description :  Get device properties for a specific component
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
unmodeled:
{
Description: The query parameter for supporting unmodeled properties. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_ReplaceComponentProperties (new)
Description :  Replace device properties for a specific component
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
body:
{
Description: Device properties. ,
Required: True ,
}
object ,
unmodeled:
{
Description: The query parameter for supporting unmodeled properties. ,
Required: False ,
}
boolean ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_UpdateComponentProperties (new)
Description :  Update device properties for a specific component via patch
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
body:
{
Description: Device properties patch. ,
Required: True ,
}
object ,
unmodeled:
{
Description: The query parameter for supporting unmodeled properties. ,
Required: False ,
}
boolean ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetComponentTelemetryValue (new)
Description :  Get the last telemetry value from a component.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/components/{componentName}/telemetry/{telemetryName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
telemetryName:
{
Description: Name of this device telemetry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The last known value of this device telemetry. ,
Required: False ,
}
string ,
timestamp:
{
Description: String-formatted date representing the time when the telemetry value was sent. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetCredentials (new)
Description :  Get device credentials
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/credentials
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
idScope:
{
Description: ID scope for connecting to the IoT Central application. ,
Required: True ,
}
string ,
symmetricKey:
{
Description: The symmetric key credentials for the device. ,
Required: False ,
}
{
primaryKey:
{
Description: The primary key for this credential. ,
Required: True ,
}
string ,
secondaryKey:
{
Description: The secondary key for this credential. ,
Required: True ,
}
string ,
}
,
x509:
{
Description: The X.509 credential information for the device. ,
Required: False ,
}
{
clientCertificates:
{
Description: The X.509 client certificates for this credential. ,
Required: False ,
}
{
primary:
{
Description: The primary X.509 certificate for this credential. ,
Required: True ,
}
{
certificate:
{
Description: The string representation of this certificate. ,
Required: False ,
}
string ,
info:
{
Description: Information about this certificate. ,
Required: False ,
}
{
sha1Thumbprint:
{
Description: The SHA-1 hash value of the certificate. ,
Required: True ,
}
string ,
}
,
}
,
secondary:
{
Description: The secondary X.509 certificate for this credential. ,
Required: False ,
}
{
certificate:
{
Description: The string representation of this certificate. ,
Required: False ,
}
string ,
info:
{
Description: Information about this certificate. ,
Required: False ,
}
{
sha1Thumbprint:
{
Description: The SHA-1 hash value of the certificate. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}
,
tpm:
{
Description: The TPM credentials for the device. ,
Required: False ,
}
{
endorsementKey:
{
Description: The TPM endorsement key for this credential. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_ListModules (new)
Description :  List the modules present in a device
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of entities. ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: URL to get the next page of entities. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetModuleCommandHistory (new)
Description :  Get module command history
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device command executions. ,
Required: True ,
}
[
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device command executions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_RunModuleCommand (new)
Description :  Run a command on a module.
Reference :  Link ¶

⚼ Request

POST:  /devices/{deviceId}/modules/{moduleName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
body:
{
Description: Device command body. ,
Required: True ,
}
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_ListModuleComponents (new)
Description :  List the components present in a module
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/components
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of entities. ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: URL to get the next page of entities. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetModuleComponentCommandHistory (new)
Description :  Get module component command history
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device command executions. ,
Required: True ,
}
[
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device command executions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_RunModuleComponentCommand (new)
Description :  Run a command on a module.
Reference :  Link ¶

⚼ Request

POST:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
body:
{
Description: Device command body. ,
Required: True ,
}
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command, support any primitive types or object. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response, support any primitive types or object. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetModuleComponentProperties (new)
Description :  Get module properties for a specific component
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_ReplaceModuleComponentProperties (new)
Description :  Replace module properties for a specific component
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
body:
{
Description: Module properties. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_UpdateModuleComponentProperties (new)
Description :  Update module properties for a specific component via patch
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
body:
{
Description: Module properties patch. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetModuleComponentTelemetryValue (new)
Description :  Get the last telemetry value from a module component.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/telemetry/{telemetryName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
telemetryName:
{
Description: Name of this device telemetry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The last known value of this device telemetry. ,
Required: False ,
}
string ,
timestamp:
{
Description: String-formatted date representing the time when the telemetry value was sent. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetModuleProperties (new)
Description :  Get all property values of a module.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_ReplaceModuleProperties (new)
Description :  Replace all property values of a module.
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/modules/{moduleName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
body:
{
Description: Module properties. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_UpdateModuleProperties (new)
Description :  Update property values of a module.
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/modules/{moduleName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
body:
{
Description: Module properties patch. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetModuleTelemetryValue (new)
Description :  Get the last telemetry value from a module.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/telemetry/{telemetryName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
telemetryName:
{
Description: Name of this device telemetry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The last known value of this device telemetry. ,
Required: False ,
}
string ,
timestamp:
{
Description: String-formatted date representing the time when the telemetry value was sent. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetProperties (new)
Description :  Get all property values of a device by device ID.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
unmodeled:
{
Description: The query parameter for supporting unmodeled properties. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_ReplaceProperties (new)
Description :  Replace all property values of a device by device ID.
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Device properties. ,
Required: True ,
}
object ,
unmodeled:
{
Description: The query parameter for supporting unmodeled properties. ,
Required: False ,
}
boolean ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_UpdateProperties (new)
Description :  Update property values of a device by device ID.
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Device properties patch. ,
Required: True ,
}
object ,
unmodeled:
{
Description: The query parameter for supporting unmodeled properties. ,
Required: False ,
}
boolean ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_ListRelationships (new)
Description :  List all relationships based on device ID
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/relationships
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: The maximum number of resources to return from one response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device relationships. ,
Required: True ,
}
[
{
id:
{
Description: The unique identifier of this relationship. ,
Required: False ,
}
string ,
source:
{
Description: The device ID of the source (parent) device. ,
Required: False ,
}
string ,
target:
{
Description: The device ID of the target (child) device. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device relationships. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetRelationship (new)
Description :  Get device relationship by ID
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/relationships/{relationshipId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
relationshipId:
{
Description: Unique ID of a relationship between devices. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique identifier of this relationship. ,
Required: False ,
}
string ,
source:
{
Description: The device ID of the source (parent) device. ,
Required: False ,
}
string ,
target:
{
Description: The device ID of the target (child) device. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_CreateRelationship (new)
Description :  Create a device relationship
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/relationships/{relationshipId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
relationshipId:
{
Description: Unique ID of a relationship between devices. ,
Required: True ,
}
string ,
body:
{
Description: Device relationship body. ,
Required: True ,
}
{
id:
{
Description: The unique identifier of this relationship. ,
Required: False ,
}
string ,
source:
{
Description: The device ID of the source (parent) device. ,
Required: False ,
}
string ,
target:
{
Description: The device ID of the target (child) device. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The unique identifier of this relationship. ,
Required: False ,
}
string ,
source:
{
Description: The device ID of the source (parent) device. ,
Required: False ,
}
string ,
target:
{
Description: The device ID of the target (child) device. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_UpdateRelationship (new)
Description :  Update device relationship
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/relationships/{relationshipId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
relationshipId:
{
Description: Unique ID of a relationship between devices. ,
Required: True ,
}
string ,
body:
{
Description: Device relationship patch body. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
id:
{
Description: The unique identifier of this relationship. ,
Required: False ,
}
string ,
source:
{
Description: The device ID of the source (parent) device. ,
Required: False ,
}
string ,
target:
{
Description: The device ID of the target (child) device. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_RemoveRelationship (new)
Description :  Delete a device relationship
Reference :  Link ¶

⚼ Request

DELETE:  /devices/{deviceId}/relationships/{relationshipId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
relationshipId:
{
Description: Unique ID of a relationship between devices. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Devices_GetTelemetryValue (new)
Description :  Get the last telemetry value from a device.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/telemetry/{telemetryName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
telemetryName:
{
Description: Name of this device telemetry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The last known value of this device telemetry. ,
Required: False ,
}
string ,
timestamp:
{
Description: String-formatted date representing the time when the telemetry value was sent. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
EnrollmentGroups_List (new)
Description :  Get the list of enrollment groups in an application
Reference :  Link ¶

⚼ Request

GET:  /enrollmentGroups
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of enrollment groups. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the enrollment group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the enrollment group. ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the devices using the group are allowed to connect to IoT Central. ,
Required: False ,
}
boolean ,
type:
{
Description: Type of devices that connect through the group. ,
Enum:
{
iot: Regular (non-Edge) IoT devices ,
iotEdge: IoT Edge devices ,
}
,
Required: True ,
}
enum ,
attestation:
{
Description: The attestation mechanism for the enrollment group. ,
Required: True ,
}
{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}
,
etag:
{
Description: ETag used to prevent conflict in enrollment group updates. ,
Required: False ,
}
string ,
idScope:
{
Description: ID scope for connecting to the IoT Central application. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of enrollment groups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
EnrollmentGroups_Get (new)
Description :  Get details about an enrollment group by ID.
Reference :  Link ¶

⚼ Request

GET:  /enrollmentGroups/{enrollmentGroupId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
enrollmentGroupId:
{
Description: Unique ID of the enrollment group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the enrollment group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the enrollment group. ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the devices using the group are allowed to connect to IoT Central. ,
Required: False ,
}
boolean ,
type:
{
Description: Type of devices that connect through the group. ,
Enum:
{
iot: Regular (non-Edge) IoT devices ,
iotEdge: IoT Edge devices ,
}
,
Required: True ,
}
enum ,
attestation:
{
Description: The attestation mechanism for the enrollment group. ,
Required: True ,
}
{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}
,
etag:
{
Description: ETag used to prevent conflict in enrollment group updates. ,
Required: False ,
}
string ,
idScope:
{
Description: ID scope for connecting to the IoT Central application. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
EnrollmentGroups_Create (new)
Description :  Create an enrollment group.
Reference :  Link ¶

⚼ Request

PUT:  /enrollmentGroups/{enrollmentGroupId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
enrollmentGroupId:
{
Description: Unique ID of the enrollment group. ,
Required: True ,
}
string ,
body:
{
Description: Enrollment group body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the enrollment group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the enrollment group. ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the devices using the group are allowed to connect to IoT Central. ,
Required: False ,
}
boolean ,
type:
{
Description: Type of devices that connect through the group. ,
Enum:
{
iot: Regular (non-Edge) IoT devices ,
iotEdge: IoT Edge devices ,
}
,
Required: True ,
}
enum ,
attestation:
{
Description: The attestation mechanism for the enrollment group. ,
Required: True ,
}
{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}
,
etag:
{
Description: ETag used to prevent conflict in enrollment group updates. ,
Required: False ,
}
string ,
idScope:
{
Description: ID scope for connecting to the IoT Central application. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the enrollment group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the enrollment group. ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the devices using the group are allowed to connect to IoT Central. ,
Required: False ,
}
boolean ,
type:
{
Description: Type of devices that connect through the group. ,
Enum:
{
iot: Regular (non-Edge) IoT devices ,
iotEdge: IoT Edge devices ,
}
,
Required: True ,
}
enum ,
attestation:
{
Description: The attestation mechanism for the enrollment group. ,
Required: True ,
}
{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}
,
etag:
{
Description: ETag used to prevent conflict in enrollment group updates. ,
Required: False ,
}
string ,
idScope:
{
Description: ID scope for connecting to the IoT Central application. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
EnrollmentGroups_Update (new)
Description :  Update an enrollment group.
Reference :  Link ¶

⚼ Request

PATCH:  /enrollmentGroups/{enrollmentGroupId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
enrollmentGroupId:
{
Description: Unique ID of the enrollment group. ,
Required: True ,
}
string ,
body:
{
Description: Enrollment group patch body. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the enrollment group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the enrollment group. ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the devices using the group are allowed to connect to IoT Central. ,
Required: False ,
}
boolean ,
type:
{
Description: Type of devices that connect through the group. ,
Enum:
{
iot: Regular (non-Edge) IoT devices ,
iotEdge: IoT Edge devices ,
}
,
Required: True ,
}
enum ,
attestation:
{
Description: The attestation mechanism for the enrollment group. ,
Required: True ,
}
{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}
,
etag:
{
Description: ETag used to prevent conflict in enrollment group updates. ,
Required: False ,
}
string ,
idScope:
{
Description: ID scope for connecting to the IoT Central application. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
EnrollmentGroups_Remove (new)
Description :  Delete an enrollment group by ID.
Reference :  Link ¶

⚼ Request

DELETE:  /enrollmentGroups/{enrollmentGroupId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
enrollmentGroupId:
{
Description: Unique ID of the enrollment group. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
EnrollmentGroups_GetX509 (new)
Description :  Get details about the primary or secondary x509 certificate of an enrollment group, if it exists.
Reference :  Link ¶

⚼ Request

GET:  /enrollmentGroups/{enrollmentGroupId}/certificates/{entry}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
enrollmentGroupId:
{
Description: Unique ID of the enrollment group. ,
Required: True ,
}
string ,
entry:
{
Description: Entry of certificate only support primary and secondary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
verified:
{
Description: Whether the certificate has been verified. ,
Required: False ,
}
boolean ,
certificate:
{
Description: The string representation of this certificate. ,
Required: False ,
}
string ,
info:
{
Description: Information about this certificate. ,
Required: False ,
}
{
sha1Thumbprint:
{
Description: The SHA-1 hash value of the certificate. ,
Required: True ,
}
string ,
}
,
etag:
{
Description: ETag used to prevent conflict across multiple updates ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
EnrollmentGroups_CreateX509 (new)
Description :  Sets the primary or secondary x509 certificate of an enrollment group.
Reference :  Link ¶

⚼ Request

PUT:  /enrollmentGroups/{enrollmentGroupId}/certificates/{entry}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
enrollmentGroupId:
{
Description: Unique ID of the enrollment group. ,
Required: True ,
}
string ,
entry:
{
Description: Entry of certificate only support primary and secondary. ,
Required: True ,
}
string ,
body:
{
Description: Certificate definition. ,
Required: True ,
}
{
verified:
{
Description: Whether the certificate has been verified. ,
Required: False ,
}
boolean ,
certificate:
{
Description: The string representation of this certificate. ,
Required: False ,
}
string ,
info:
{
Description: Information about this certificate. ,
Required: False ,
}
{
sha1Thumbprint:
{
Description: The SHA-1 hash value of the certificate. ,
Required: True ,
}
string ,
}
,
etag:
{
Description: ETag used to prevent conflict across multiple updates ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
verified:
{
Description: Whether the certificate has been verified. ,
Required: False ,
}
boolean ,
certificate:
{
Description: The string representation of this certificate. ,
Required: False ,
}
string ,
info:
{
Description: Information about this certificate. ,
Required: False ,
}
{
sha1Thumbprint:
{
Description: The SHA-1 hash value of the certificate. ,
Required: True ,
}
string ,
}
,
etag:
{
Description: ETag used to prevent conflict across multiple updates ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
EnrollmentGroups_RemoveX509 (new)
Description :  Removes the primary or secondary x509 certificate of an enrollment group.
Reference :  Link ¶

⚼ Request

DELETE:  /enrollmentGroups/{enrollmentGroupId}/certificates/{entry}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
enrollmentGroupId:
{
Description: Unique ID of the enrollment group. ,
Required: True ,
}
string ,
entry:
{
Description: Entry of certificate only support primary and secondary. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
EnrollmentGroups_GenerateVerificationCodeX509 (new)
Description :  Generate a verification code for the primary or secondary x509 certificate of an enrollment group.
Reference :  Link ¶

⚼ Request

POST:  /enrollmentGroups/{enrollmentGroupId}/certificates/{entry}/generateVerificationCode
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
enrollmentGroupId:
{
Description: Unique ID of the enrollment group. ,
Required: True ,
}
string ,
entry:
{
Description: Entry of certificate only support primary and secondary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
verificationCode:
{
Description: The X509 certificate verification code. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
EnrollmentGroups_VerifyX509 (new)
Description :  Verify the primary or secondary x509 certificate of an enrollment group by providing a certificate with the signed verification code.
Reference :  Link ¶

⚼ Request

POST:  /enrollmentGroups/{enrollmentGroupId}/certificates/{entry}/verify
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
enrollmentGroupId:
{
Description: Unique ID of the enrollment group. ,
Required: True ,
}
string ,
entry:
{
Description: Entry of certificate only support primary and secondary. ,
Required: True ,
}
string ,
body:
{
Description: Certificate for the signed verification code. ,
Required: True ,
}
{
certificate:
{
Description: The string representation of this certificate. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
FileUploads_Get (new)
Description :  Get the file upload storage account configuration.
Reference :  Link ¶

⚼ Request

GET:  /fileUploads
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
account:
{
Description: The storage account name where to upload the file to ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string used to configure the storage account ,
Required: True ,
}
string ,
container:
{
Description: The name of the container inside the storage account ,
Required: True ,
}
string ,
sasTtl:
{
Description: ISO 8601 duration standard, The amount of time the device’s request to upload a file is valid before it expires. ,
Required: False ,
}
string ,
state:
{
Description: The state of the file upload configuration ,
Enum:
{
pending: No description available. ,
updating: No description available. ,
deleting: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: ETag used to prevent conflict with multiple uploads ,
Required: False ,
}
string ,
readAccess:
{
Description: The flag indicate if user be able to access device uploaded files from IoT Central portal ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
FileUploads_Create (new)
Description :  Create the file upload storage account configuration.
Reference :  Link ¶

⚼ Request

PUT:  /fileUploads
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
body:
{
Description: File upload storage account configuration body. ,
Required: True ,
}
{
account:
{
Description: The storage account name where to upload the file to ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string used to configure the storage account ,
Required: True ,
}
string ,
container:
{
Description: The name of the container inside the storage account ,
Required: True ,
}
string ,
sasTtl:
{
Description: ISO 8601 duration standard, The amount of time the device’s request to upload a file is valid before it expires. ,
Required: False ,
}
string ,
state:
{
Description: The state of the file upload configuration ,
Enum:
{
pending: No description available. ,
updating: No description available. ,
deleting: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: ETag used to prevent conflict with multiple uploads ,
Required: False ,
}
string ,
readAccess:
{
Description: The flag indicate if user be able to access device uploaded files from IoT Central portal ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
account:
{
Description: The storage account name where to upload the file to ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string used to configure the storage account ,
Required: True ,
}
string ,
container:
{
Description: The name of the container inside the storage account ,
Required: True ,
}
string ,
sasTtl:
{
Description: ISO 8601 duration standard, The amount of time the device’s request to upload a file is valid before it expires. ,
Required: False ,
}
string ,
state:
{
Description: The state of the file upload configuration ,
Enum:
{
pending: No description available. ,
updating: No description available. ,
deleting: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: ETag used to prevent conflict with multiple uploads ,
Required: False ,
}
string ,
readAccess:
{
Description: The flag indicate if user be able to access device uploaded files from IoT Central portal ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
FileUploads_Update (new)
Description :  Update the file upload storage account configuration
Reference :  Link ¶

⚼ Request

PATCH:  /fileUploads
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
body:
{
Description: File upload storage account configuration body. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
account:
{
Description: The storage account name where to upload the file to ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string used to configure the storage account ,
Required: True ,
}
string ,
container:
{
Description: The name of the container inside the storage account ,
Required: True ,
}
string ,
sasTtl:
{
Description: ISO 8601 duration standard, The amount of time the device’s request to upload a file is valid before it expires. ,
Required: False ,
}
string ,
state:
{
Description: The state of the file upload configuration ,
Enum:
{
pending: No description available. ,
updating: No description available. ,
deleting: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: ETag used to prevent conflict with multiple uploads ,
Required: False ,
}
string ,
readAccess:
{
Description: The flag indicate if user be able to access device uploaded files from IoT Central portal ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
FileUploads_Remove (new)
Description :  Delete the file upload storage configuration.
Reference :  Link ¶

⚼ Request

DELETE:  /fileUploads
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_List (new)
Description :  Get the list of jobs in an application
Reference :  Link ¶

⚼ Request

GET:  /jobs
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: The maximum number of resources to return from one response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The collection of jobs. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the job. ,
Required: False ,
}
string ,
scheduledJobId:
{
Description: Id of the scheduled job definition that created this job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job Batching based on number of devices. ,
percentage: Job Batching based percentage of total applied devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job cancellation threshold based on specified number of devices. ,
percentage: Job cancellation threshold based on percentage of total devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: The capabilities being updated by the job and the values with which they are being updated. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
}
,
]
,
start:
{
Description: The start time of the job ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: The end time of the job ,
Format: date-time ,
Required: False ,
}
string ,
progress:
{
Description: The progress statistics of the job. ,
Required: False ,
}
{
total:
{
Description: The total number of entities targeted by the job. ,
Format: int32 ,
Required: False ,
}
integer ,
pending:
{
Description: The number of entities for which the job is not yet running. ,
Format: int32 ,
Required: False ,
}
integer ,
completed:
{
Description: The number of entities for which the job has completed. ,
Format: int32 ,
Required: False ,
}
integer ,
failed:
{
Description: The number of entities for which the job has failed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
status:
{
Description: Indicates whether the job is starting, running, etc. ,
Required: False ,
}
string ,
organizations:
{
Description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next page of jobs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_Get (new)
Description :  Get details about a running or completed job by job ID.
Reference :  Link ¶

⚼ Request

GET:  /jobs/{jobId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the job. ,
Required: False ,
}
string ,
scheduledJobId:
{
Description: Id of the scheduled job definition that created this job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job Batching based on number of devices. ,
percentage: Job Batching based percentage of total applied devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job cancellation threshold based on specified number of devices. ,
percentage: Job cancellation threshold based on percentage of total devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: The capabilities being updated by the job and the values with which they are being updated. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
}
,
]
,
start:
{
Description: The start time of the job ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: The end time of the job ,
Format: date-time ,
Required: False ,
}
string ,
progress:
{
Description: The progress statistics of the job. ,
Required: False ,
}
{
total:
{
Description: The total number of entities targeted by the job. ,
Format: int32 ,
Required: False ,
}
integer ,
pending:
{
Description: The number of entities for which the job is not yet running. ,
Format: int32 ,
Required: False ,
}
integer ,
completed:
{
Description: The number of entities for which the job has completed. ,
Format: int32 ,
Required: False ,
}
integer ,
failed:
{
Description: The number of entities for which the job has failed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
status:
{
Description: Indicates whether the job is starting, running, etc. ,
Required: False ,
}
string ,
organizations:
{
Description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_Create (new)
Description :  Create and execute a new job via its job definition.
Reference :  Link ¶

⚼ Request

PUT:  /jobs/{jobId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
body:
{
Description: Job definition. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the job. ,
Required: False ,
}
string ,
scheduledJobId:
{
Description: Id of the scheduled job definition that created this job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job Batching based on number of devices. ,
percentage: Job Batching based percentage of total applied devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job cancellation threshold based on specified number of devices. ,
percentage: Job cancellation threshold based on percentage of total devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: The capabilities being updated by the job and the values with which they are being updated. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
}
,
]
,
start:
{
Description: The start time of the job ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: The end time of the job ,
Format: date-time ,
Required: False ,
}
string ,
progress:
{
Description: The progress statistics of the job. ,
Required: False ,
}
{
total:
{
Description: The total number of entities targeted by the job. ,
Format: int32 ,
Required: False ,
}
integer ,
pending:
{
Description: The number of entities for which the job is not yet running. ,
Format: int32 ,
Required: False ,
}
integer ,
completed:
{
Description: The number of entities for which the job has completed. ,
Format: int32 ,
Required: False ,
}
integer ,
failed:
{
Description: The number of entities for which the job has failed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
status:
{
Description: Indicates whether the job is starting, running, etc. ,
Required: False ,
}
string ,
organizations:
{
Description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the job. ,
Required: False ,
}
string ,
scheduledJobId:
{
Description: Id of the scheduled job definition that created this job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job Batching based on number of devices. ,
percentage: Job Batching based percentage of total applied devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job cancellation threshold based on specified number of devices. ,
percentage: Job cancellation threshold based on percentage of total devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: The capabilities being updated by the job and the values with which they are being updated. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
}
,
]
,
start:
{
Description: The start time of the job ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: The end time of the job ,
Format: date-time ,
Required: False ,
}
string ,
progress:
{
Description: The progress statistics of the job. ,
Required: False ,
}
{
total:
{
Description: The total number of entities targeted by the job. ,
Format: int32 ,
Required: False ,
}
integer ,
pending:
{
Description: The number of entities for which the job is not yet running. ,
Format: int32 ,
Required: False ,
}
integer ,
completed:
{
Description: The number of entities for which the job has completed. ,
Format: int32 ,
Required: False ,
}
integer ,
failed:
{
Description: The number of entities for which the job has failed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
status:
{
Description: Indicates whether the job is starting, running, etc. ,
Required: False ,
}
string ,
organizations:
{
Description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_GetDevices (new)
Description :  Get the list of individual device statuses by job ID.
Reference :  Link ¶

⚼ Request

GET:  /jobs/{jobId}/devices
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of job device statuses. ,
Required: True ,
}
[
{
id:
{
Description: ID of the device whose job status is being provided. ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether the job is starting, running, etc. for the given device. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of job device statuses. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_Rerun (new)
Description :  Execute a rerun of an existing job on all failed devices.
Reference :  Link ¶

⚼ Request

PUT:  /jobs/{jobId}/rerun/{rerunId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
rerunId:
{
Description: Unique ID of the job rerun. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the job. ,
Required: False ,
}
string ,
scheduledJobId:
{
Description: Id of the scheduled job definition that created this job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job Batching based on number of devices. ,
percentage: Job Batching based percentage of total applied devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job cancellation threshold based on specified number of devices. ,
percentage: Job cancellation threshold based on percentage of total devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: The capabilities being updated by the job and the values with which they are being updated. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
}
,
]
,
start:
{
Description: The start time of the job ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: The end time of the job ,
Format: date-time ,
Required: False ,
}
string ,
progress:
{
Description: The progress statistics of the job. ,
Required: False ,
}
{
total:
{
Description: The total number of entities targeted by the job. ,
Format: int32 ,
Required: False ,
}
integer ,
pending:
{
Description: The number of entities for which the job is not yet running. ,
Format: int32 ,
Required: False ,
}
integer ,
completed:
{
Description: The number of entities for which the job has completed. ,
Format: int32 ,
Required: False ,
}
integer ,
failed:
{
Description: The number of entities for which the job has failed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
status:
{
Description: Indicates whether the job is starting, running, etc. ,
Required: False ,
}
string ,
organizations:
{
Description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_Resume (new)
Description :  Resume execution of an existing stopped job.
Reference :  Link ¶

⚼ Request

POST:  /jobs/{jobId}/resume
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_Stop (new)
Description :  Stop execution of a job that is currently running.
Reference :  Link ¶

⚼ Request

POST:  /jobs/{jobId}/stop
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Organizations_List (new)
Description :  Get the list of organizations the user has access to in an application
Reference :  Link ¶

⚼ Request

GET:  /organizations
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of organizations. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the organization. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the organization. ,
Required: False ,
}
string ,
parent:
{
Description: ID of the parent of the organization. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of organizations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Organizations_Get (new)
Description :  Get an organization by ID
Reference :  Link ¶

⚼ Request

GET:  /organizations/{organizationId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
organizationId:
{
Description: Unique ID for the organization. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the organization. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the organization. ,
Required: False ,
}
string ,
parent:
{
Description: ID of the parent of the organization. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Organizations_Create (new)
Description :  Create an organization in the application
Reference :  Link ¶

⚼ Request

PUT:  /organizations/{organizationId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
organizationId:
{
Description: Unique ID for the organization. ,
Required: True ,
}
string ,
body:
{
Description: Organization body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the organization. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the organization. ,
Required: False ,
}
string ,
parent:
{
Description: ID of the parent of the organization. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the organization. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the organization. ,
Required: False ,
}
string ,
parent:
{
Description: ID of the parent of the organization. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Organizations_Update (new)
Description :  Update an organization in the application via patch
Reference :  Link ¶

⚼ Request

PATCH:  /organizations/{organizationId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
organizationId:
{
Description: Unique ID for the organization. ,
Required: True ,
}
string ,
body:
{
Description: Organization patch body. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the organization. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the organization. ,
Required: False ,
}
string ,
parent:
{
Description: ID of the parent of the organization. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Organizations_Remove (new)
Description :  Delete an organization
Reference :  Link ¶

⚼ Request

DELETE:  /organizations/{organizationId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
organizationId:
{
Description: Unique ID for the organization. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Query_Run (new)
Description :  Run a query and obtain the result
Reference :  Link ¶

⚼ Request

POST:  /query
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
body:
{
Description: query, more details on [IoT central query language](https://aka.ms/iotcql). ,
Required: True ,
}
{
query:
{
Description: Query to be executed. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
results:
{
Required: True ,
}
[
object ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Roles_List (new)
Description :  Get the list of roles in an application.
Reference :  Link ¶

⚼ Request

GET:  /roles
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of roles. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the role. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the role. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of roles. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Roles_Get (new)
Description :  Get a role by ID.
Reference :  Link ¶

⚼ Request

GET:  /roles/{roleId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
roleId:
{
Description: Unique ID for the role. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the role. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the role. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
ScheduledJobs_List (new)
Description :  Get the list of scheduled job definitions in an application
Reference :  Link ¶

⚼ Request

GET:  /scheduledJobs
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: The maximum number of resources to return from one response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The collection of scheduled jobs. ,
Required: True ,
}
[
{
etag:
{
Description: ETag used to prevent conflict in scheduled job updates. ,
Required: False ,
}
string ,
id:
{
Description: Unique ID of the scheduled job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the scheduled job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the scheduled job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the scheduled job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job Batching based on number of devices. ,
percentage: Job Batching based percentage of total applied devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job cancellation threshold based on specified number of devices. ,
percentage: Job cancellation threshold based on percentage of total devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: Data related to the operation being performed by this job. All entries must be of the same type. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
}
,
]
,
organizations:
{
Description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
schedule:
{
Description: The schedule at which to execute the job. ,
Required: True ,
}
{
recurrence:
{
Description: The recurrence of the scheduled job. If not provided, the job will run once at the specified start time. ,
Enum:
{
daily: The job will run once daily ,
weekly: The job will run once every week ,
monthly: The job will run once every month ,
}
,
Required: False ,
}
enum ,
start:
{
Description: The start time for the scheduled job ,
Format: date-time ,
Required: True ,
}
string ,
end:
{
Description: The specification of when to end the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Type of the job schedule end. ,
Required: True ,
}
string ,
}
,
}
,
enabled:
{
Description: Whether the scheduled job is enabled. ,
Required: False ,
}
boolean ,
completed:
{
Description: Whether the scheduled job has completed. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of scheduled jobs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
ScheduledJobs_Get (new)
Description :  Get details about a scheduled job by ID.
Reference :  Link ¶

⚼ Request

GET:  /scheduledJobs/{scheduledJobId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
scheduledJobId:
{
Description: Unique ID of the scheduled job. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag used to prevent conflict in scheduled job updates. ,
Required: False ,
}
string ,
id:
{
Description: Unique ID of the scheduled job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the scheduled job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the scheduled job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the scheduled job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job Batching based on number of devices. ,
percentage: Job Batching based percentage of total applied devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job cancellation threshold based on specified number of devices. ,
percentage: Job cancellation threshold based on percentage of total devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: Data related to the operation being performed by this job. All entries must be of the same type. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
}
,
]
,
organizations:
{
Description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
schedule:
{
Description: The schedule at which to execute the job. ,
Required: True ,
}
{
recurrence:
{
Description: The recurrence of the scheduled job. If not provided, the job will run once at the specified start time. ,
Enum:
{
daily: The job will run once daily ,
weekly: The job will run once every week ,
monthly: The job will run once every month ,
}
,
Required: False ,
}
enum ,
start:
{
Description: The start time for the scheduled job ,
Format: date-time ,
Required: True ,
}
string ,
end:
{
Description: The specification of when to end the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Type of the job schedule end. ,
Required: True ,
}
string ,
}
,
}
,
enabled:
{
Description: Whether the scheduled job is enabled. ,
Required: False ,
}
boolean ,
completed:
{
Description: Whether the scheduled job has completed. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
ScheduledJobs_Create (new)
Description :  Create or update a scheduled job by ID.
Reference :  Link ¶

⚼ Request

PUT:  /scheduledJobs/{scheduledJobId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
scheduledJobId:
{
Description: Unique ID of the scheduled job. ,
Required: True ,
}
string ,
body:
{
Description: Scheduled job definition. ,
Required: True ,
}
{
etag:
{
Description: ETag used to prevent conflict in scheduled job updates. ,
Required: False ,
}
string ,
id:
{
Description: Unique ID of the scheduled job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the scheduled job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the scheduled job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the scheduled job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job Batching based on number of devices. ,
percentage: Job Batching based percentage of total applied devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job cancellation threshold based on specified number of devices. ,
percentage: Job cancellation threshold based on percentage of total devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: Data related to the operation being performed by this job. All entries must be of the same type. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
}
,
]
,
organizations:
{
Description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
schedule:
{
Description: The schedule at which to execute the job. ,
Required: True ,
}
{
recurrence:
{
Description: The recurrence of the scheduled job. If not provided, the job will run once at the specified start time. ,
Enum:
{
daily: The job will run once daily ,
weekly: The job will run once every week ,
monthly: The job will run once every month ,
}
,
Required: False ,
}
enum ,
start:
{
Description: The start time for the scheduled job ,
Format: date-time ,
Required: True ,
}
string ,
end:
{
Description: The specification of when to end the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Type of the job schedule end. ,
Required: True ,
}
string ,
}
,
}
,
enabled:
{
Description: Whether the scheduled job is enabled. ,
Required: False ,
}
boolean ,
completed:
{
Description: Whether the scheduled job has completed. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: ETag used to prevent conflict in scheduled job updates. ,
Required: False ,
}
string ,
id:
{
Description: Unique ID of the scheduled job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the scheduled job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the scheduled job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the scheduled job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job Batching based on number of devices. ,
percentage: Job Batching based percentage of total applied devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job cancellation threshold based on specified number of devices. ,
percentage: Job cancellation threshold based on percentage of total devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: Data related to the operation being performed by this job. All entries must be of the same type. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
}
,
]
,
organizations:
{
Description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
schedule:
{
Description: The schedule at which to execute the job. ,
Required: True ,
}
{
recurrence:
{
Description: The recurrence of the scheduled job. If not provided, the job will run once at the specified start time. ,
Enum:
{
daily: The job will run once daily ,
weekly: The job will run once every week ,
monthly: The job will run once every month ,
}
,
Required: False ,
}
enum ,
start:
{
Description: The start time for the scheduled job ,
Format: date-time ,
Required: True ,
}
string ,
end:
{
Description: The specification of when to end the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Type of the job schedule end. ,
Required: True ,
}
string ,
}
,
}
,
enabled:
{
Description: Whether the scheduled job is enabled. ,
Required: False ,
}
boolean ,
completed:
{
Description: Whether the scheduled job has completed. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
ScheduledJobs_Update (new)
Description :  Update an existing scheduled job by ID.
Reference :  Link ¶

⚼ Request

PATCH:  /scheduledJobs/{scheduledJobId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
scheduledJobId:
{
Description: Unique ID of the scheduled job. ,
Required: True ,
}
string ,
body:
{
Description: Scheduled job patch. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag used to prevent conflict in scheduled job updates. ,
Required: False ,
}
string ,
id:
{
Description: Unique ID of the scheduled job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the scheduled job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the scheduled job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the scheduled job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job Batching based on number of devices. ,
percentage: Job Batching based percentage of total applied devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job cancellation threshold based on specified number of devices. ,
percentage: Job cancellation threshold based on percentage of total devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: Data related to the operation being performed by this job. All entries must be of the same type. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
}
,
]
,
organizations:
{
Description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
schedule:
{
Description: The schedule at which to execute the job. ,
Required: True ,
}
{
recurrence:
{
Description: The recurrence of the scheduled job. If not provided, the job will run once at the specified start time. ,
Enum:
{
daily: The job will run once daily ,
weekly: The job will run once every week ,
monthly: The job will run once every month ,
}
,
Required: False ,
}
enum ,
start:
{
Description: The start time for the scheduled job ,
Format: date-time ,
Required: True ,
}
string ,
end:
{
Description: The specification of when to end the scheduled job. ,
Required: False ,
}
{
type:
{
Description: Type of the job schedule end. ,
Required: True ,
}
string ,
}
,
}
,
enabled:
{
Description: Whether the scheduled job is enabled. ,
Required: False ,
}
boolean ,
completed:
{
Description: Whether the scheduled job has completed. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
ScheduledJobs_Remove (new)
Description :  Delete an existing scheduled job by ID.
Reference :  Link ¶

⚼ Request

DELETE:  /scheduledJobs/{scheduledJobId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
scheduledJobId:
{
Description: Unique ID of the scheduled job. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
ScheduledJobs_ListJobs (new)
Description :  Get the list of jobs for a scheduled job definition
Reference :  Link ¶

⚼ Request

GET:  /scheduledJobs/{scheduledJobId}/jobs
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
scheduledJobId:
{
Description: Unique ID of the scheduled job. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: The maximum number of resources to return from one response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The collection of jobs. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the job. ,
Required: False ,
}
string ,
scheduledJobId:
{
Description: Id of the scheduled job definition that created this job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job Batching based on number of devices. ,
percentage: Job Batching based percentage of total applied devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: Job cancellation threshold based on specified number of devices. ,
percentage: Job cancellation threshold based on percentage of total devices. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: The capabilities being updated by the job and the values with which they are being updated. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
}
,
]
,
start:
{
Description: The start time of the job ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: The end time of the job ,
Format: date-time ,
Required: False ,
}
string ,
progress:
{
Description: The progress statistics of the job. ,
Required: False ,
}
{
total:
{
Description: The total number of entities targeted by the job. ,
Format: int32 ,
Required: False ,
}
integer ,
pending:
{
Description: The number of entities for which the job is not yet running. ,
Format: int32 ,
Required: False ,
}
integer ,
completed:
{
Description: The number of entities for which the job has completed. ,
Format: int32 ,
Required: False ,
}
integer ,
failed:
{
Description: The number of entities for which the job has failed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
status:
{
Description: Indicates whether the job is starting, running, etc. ,
Required: False ,
}
string ,
organizations:
{
Description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next page of jobs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Users_List (new)
Description :  Get the list of users in an application
Reference :  Link ¶

⚼ Request

GET:  /users
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: The maximum number of resources to return from one response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The collection of users. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the user. ,
Required: False ,
}
string ,
type:
{
Description: Type of the user. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of users. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Users_Get (new)
Description :  Get a user by ID
Reference :  Link ¶

⚼ Request

GET:  /users/{userId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
userId:
{
Description: Unique ID for the user. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the user. ,
Required: False ,
}
string ,
type:
{
Description: Type of the user. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Users_Create (new)
Description :  Create a user in the application
Reference :  Link ¶

⚼ Request

PUT:  /users/{userId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
userId:
{
Description: Unique ID for the user. ,
Required: True ,
}
string ,
body:
{
Description: User body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the user. ,
Required: False ,
}
string ,
type:
{
Description: Type of the user. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the user. ,
Required: False ,
}
string ,
type:
{
Description: Type of the user. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Users_Update (new)
Description :  Update a user in the application via patch
Reference :  Link ¶

⚼ Request

PATCH:  /users/{userId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
userId:
{
Description: Unique ID for the user. ,
Required: True ,
}
string ,
body:
{
Description: User patch body. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the user. ,
Required: False ,
}
string ,
type:
{
Description: Type of the user. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}
Users_Remove (new)
Description :  Delete a user
Reference :  Link ¶

⚼ Request

DELETE:  /users/{userId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
userId:
{
Description: Unique ID for the user. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The response error definition. ,
}
{
error:
{
Description: Error details for current request. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message details. ,
Required: True ,
}
string ,
requestId:
{
Description: Correlation Id for current request. ,
Required: False ,
}
string ,
time:
{
Description: The time that error request failed. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
}
,
}